Attaching comment block to a specific variable / enum / define ( var )
The var command is used to explicitly link a documentation comment block to the specified variable / enum or define. When documenting variables it's necessary to specify the type of the variable also. The
\var
command is also used when documenting enum values in a separate file, see
SepDocClass::ClassEnum SepDocClass::eClassEnumVal1 for an example. Also it's important to qualify the name with full scope.
Output
The var command does not produce any output of its own, but secures that the comment block as a whole is used to produce the documentation of the specified class. But see
SepDocClass::ClassUnion::m_iClassUnionIntMember.
About putting the documentation in separate files
This command is used for documenting an entity away from it's definition in the code. See SeparateDocs for some examples.
The commands for making separate documentation are:
\class, \def, \enum, (\file), \fn, \namespace, \struct, \typedef, \union \var
Qualify with scope (class, namepace) if inside a scope like this: